Skip to content

[python][client] Add Decimal support to mapNumberTo functionality#23916

Open
Mattias-Sehlstedt wants to merge 1 commit into
OpenAPITools:masterfrom
Mattias-Sehlstedt:python-import-mappings
Open

[python][client] Add Decimal support to mapNumberTo functionality#23916
Mattias-Sehlstedt wants to merge 1 commit into
OpenAPITools:masterfrom
Mattias-Sehlstedt:python-import-mappings

Conversation

@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor

@Mattias-Sehlstedt Mattias-Sehlstedt commented May 31, 2026

Add so that the Python generator support so that the number type can be mapped to Decimal. Note that the is strictly for the Python generator, and not for the python-pydantic-v1 generator. This is intentional since they are based upon different AbstractCodegens that do not share their logic. If it is of interest to have all Python generators share this new behavior I would suggest creating a shared type resolver so that all Python generators could get the same functionality without code duplication.

The mapNumberTo function is retained as a scoped (argument-limited) function rather than a completely open one. This since the Python validation logic required outside knowledge that is currently not injectable by the client, so having an open function might currently be counterintuitive.

Fixes: #23887

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

cc @taxpon (2017/07) @frol (2017/07) @mbohlool (2017/07) @cbornet (2017/09) @kenjones-cisco (2017/11) @tomplus (2018/10) @arun-nalla (2019/11)


Summary by cubic

Adds support for mapping OpenAPI number types to Decimal in the python client via mapNumberTo, enabling high‑precision values (e.g., money) while preserving validation. Fixes #23887.

  • New Features

    • mapNumberTo now accepts Decimal (supported: Union[StrictFloat, StrictInt], StrictFloat, float, Decimal) and keeps numeric constraints.
    • Generates correct imports/types; error message now lists all supported values.
    • Docs and CLI help updated to include Decimal and StrictFloat; tests verify all mappings with a data provider.
    • Scope: python generator only; not python-pydantic-v1.
  • Migration

    • Set mapNumberTo: "Decimal" in the generator config (Python generator only).

Written for commit 93a44d4. Summary will update on new commits.

Review in cubic

@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the python-import-mappings branch 11 times, most recently from 442b05b to 39a2afe Compare June 2, 2026 19:07
@Mattias-Sehlstedt Mattias-Sehlstedt marked this pull request as ready for review June 2, 2026 19:28
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 4 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

@Mattias-Sehlstedt Mattias-Sehlstedt force-pushed the python-import-mappings branch from 39a2afe to 93a44d4 Compare June 2, 2026 19:40
@Mattias-Sehlstedt Mattias-Sehlstedt changed the title [Python] [Client] Add so that Python mapNumberTo supports Decimal [python][client] Add Decimal support to mapNumberTo functionality Jun 2, 2026
@wing328
Copy link
Copy Markdown
Member

wing328 commented Jun 3, 2026

please resolve the merge conflicts when you've time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] [PYTHON] Unable to map number types to decimal.Decimal

2 participants